<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.hackystat.telemetry.analyzer.function;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import org.hackystat.telemetry.analyzer.function.jaxb.FunctionDefinition;<a name="line.3"></a>
<FONT color="green">004</FONT>    import org.hackystat.telemetry.analyzer.function.jaxb.Parameters;<a name="line.4"></a>
<FONT color="green">005</FONT>    <a name="line.5"></a>
<FONT color="green">006</FONT>    /**<a name="line.6"></a>
<FONT color="green">007</FONT>     * Provides information about a specific implementation of a TelemetryFunction. <a name="line.7"></a>
<FONT color="green">008</FONT>     * <a name="line.8"></a>
<FONT color="green">009</FONT>     * @author (Cedric) Qin Zhang, Philip Johnson<a name="line.9"></a>
<FONT color="green">010</FONT>     */<a name="line.10"></a>
<FONT color="green">011</FONT>    public class TelemetryFunctionInfo {<a name="line.11"></a>
<FONT color="green">012</FONT>    <a name="line.12"></a>
<FONT color="green">013</FONT>      private TelemetryFunction function;<a name="line.13"></a>
<FONT color="green">014</FONT>      private FunctionDefinition definition;<a name="line.14"></a>
<FONT color="green">015</FONT>    <a name="line.15"></a>
<FONT color="green">016</FONT>      /**<a name="line.16"></a>
<FONT color="green">017</FONT>       * Constructs this instance.<a name="line.17"></a>
<FONT color="green">018</FONT>       * <a name="line.18"></a>
<FONT color="green">019</FONT>       * @param function The concrete instance of telemetry function.<a name="line.19"></a>
<FONT color="green">020</FONT>       * @param definition The definition of this function, from the JAXB XML class.<a name="line.20"></a>
<FONT color="green">021</FONT>       */<a name="line.21"></a>
<FONT color="green">022</FONT>      TelemetryFunctionInfo(TelemetryFunction function, FunctionDefinition definition) {<a name="line.22"></a>
<FONT color="green">023</FONT>        this.function = function;<a name="line.23"></a>
<FONT color="green">024</FONT>        this.definition = definition;<a name="line.24"></a>
<FONT color="green">025</FONT>      }<a name="line.25"></a>
<FONT color="green">026</FONT>    <a name="line.26"></a>
<FONT color="green">027</FONT>      /**<a name="line.27"></a>
<FONT color="green">028</FONT>       * Gets the name of the telemetry function.<a name="line.28"></a>
<FONT color="green">029</FONT>       * <a name="line.29"></a>
<FONT color="green">030</FONT>       * @return The name.<a name="line.30"></a>
<FONT color="green">031</FONT>       */<a name="line.31"></a>
<FONT color="green">032</FONT>      public String getName() {<a name="line.32"></a>
<FONT color="green">033</FONT>        return this.function.getName();<a name="line.33"></a>
<FONT color="green">034</FONT>      }<a name="line.34"></a>
<FONT color="green">035</FONT>    <a name="line.35"></a>
<FONT color="green">036</FONT>      /**<a name="line.36"></a>
<FONT color="green">037</FONT>       * Gets the instance of the telemetry function.<a name="line.37"></a>
<FONT color="green">038</FONT>       * <a name="line.38"></a>
<FONT color="green">039</FONT>       * @return The instance.<a name="line.39"></a>
<FONT color="green">040</FONT>       */<a name="line.40"></a>
<FONT color="green">041</FONT>      public TelemetryFunction getFunction() {<a name="line.41"></a>
<FONT color="green">042</FONT>        return this.function;<a name="line.42"></a>
<FONT color="green">043</FONT>      }<a name="line.43"></a>
<FONT color="green">044</FONT>    <a name="line.44"></a>
<FONT color="green">045</FONT>      /**<a name="line.45"></a>
<FONT color="green">046</FONT>       * Gets the description of this function.<a name="line.46"></a>
<FONT color="green">047</FONT>       * <a name="line.47"></a>
<FONT color="green">048</FONT>       * @return The description of the function.<a name="line.48"></a>
<FONT color="green">049</FONT>       */<a name="line.49"></a>
<FONT color="green">050</FONT>      public String getFunctionDescription() {<a name="line.50"></a>
<FONT color="green">051</FONT>        return this.definition.getDescription();<a name="line.51"></a>
<FONT color="green">052</FONT>      }<a name="line.52"></a>
<FONT color="green">053</FONT>    <a name="line.53"></a>
<FONT color="green">054</FONT>      /**<a name="line.54"></a>
<FONT color="green">055</FONT>       * Gets the description of the parameters this function takes if any.<a name="line.55"></a>
<FONT color="green">056</FONT>       * <a name="line.56"></a>
<FONT color="green">057</FONT>       * @return The description of the parameters.<a name="line.57"></a>
<FONT color="green">058</FONT>       */<a name="line.58"></a>
<FONT color="green">059</FONT>      public Parameters getParameterDescription() {<a name="line.59"></a>
<FONT color="green">060</FONT>        return this.definition.getParameters();<a name="line.60"></a>
<FONT color="green">061</FONT>      }<a name="line.61"></a>
<FONT color="green">062</FONT>    }<a name="line.62"></a>




























































</PRE>
</BODY>
</HTML>
